home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / program / 355 / release.doc < prev    next >
Text File  |  1992-03-11  |  14KB  |  271 lines
  1.           RELEASE NOTES FOR M2/68 VERSION 1.01
  2.           
  3.           INTRODUCTION:
  4.           
  5.           The ana-systems Modula-2 Development System consists of the 
  6.           M2/68 Compiler, Linker, libraries, and Development Shell.  
  7.           The libraries and the Shell were written in Modula-2 and 
  8.           compiled with the ana-systems M2/68 Compiler.
  9.           
  10.           This distribution contains full Atari system libraries which
  11.           adhere closely to C naming conventions.
  12.           
  13.           PACKING LIST:
  14.           
  15.           You should find the following files in your package:
  16.           
  17.               ana_1.arc:
  18.                     m2sh.prg       Development Shell
  19.                     m2sh.rsc       English resource file for Shell
  20.                     m2sh_g.rsc     German resource file
  21.                     m2sh.cfg       configuration file for Shell
  22.                     utility.prg    disk utilities program
  23.                     utility.rsc    English resource file for utility.prg
  24.                     util_g.rsc     German resource file
  25.                     readme         read this first
  26.                     release.doc    this document
  27.                     info.doc       product registration form
  28.                     version.doc    the current version
  29.                     copyrigh.doc   copyright message
  30.                     license.doc    your SHAREWARE license
  31.                     ana_prof.doc   profile of ana-systems
  32.                     m2_desc.doc    general description of the M2/68 product
  33.                     sample.ord     product ordering samples
  34.               ana_2.arc:
  35.                     m2.tos         M2/68 Compiler
  36.               ana_3.arc:
  37.                     m2lnk.tos      M2/68 Linker
  38.               ana_4.arc:
  39.                     *.def          library Definition files
  40.               ana_5.arc:
  41.                     *.sym          library .SYM files
  42.               ana_6.arc:
  43.                     *.obj          library .OBJ files
  44.               ana_7.arc:
  45.                     emacs.tos      public domain editor
  46.                     emacs.rc       emacs key binding resource
  47.                     emacs.hlp      command list
  48.                     emacs.key      default key binding
  49.                     
  50.           All archives also contain Copyright, License, and Version
  51.           documents.
  52.  
  53.           SYSTEM REQUIREMENTS AND RESTRICTIONS:
  54.           
  55.           The minimum hardware requirements to use the M2/68 system are 
  56.           a 520ST with 2 disk drives (single or double sided) or a 
  57.           1040ST with 1 double sided drive.  What this boils down to is 
  58.           minimum 1 meg and a double sided drive, or 1/2 meg and 2 
  59.           drives.  (See 'Configurations' below for recommended setups.)
  60.           
  61.           The M2/68 Compiler needs about 300K of RAM to compile a small 
  62.           to medium sized program.  If you are using a 512K machine,
  63.           this means you can run the Compiler from the Development 
  64.           Shell but you probably can't use many desk accessories and 
  65.           you  definitely can't use a RAM disk to speed things up.  If 
  66.           you are in this category and the Compiler issues an 'out of 
  67.           memory' message, you must reduce your memory consumption.  You
  68.           can do this by either removing desk accessories (including the 
  69.           control panel) and/or reducing the size of the module you are 
  70.           compiling.  If you have a megabyte of memory you can create a 
  71.           RAM disk and load the libraries into it to speed up 
  72.           compilation and linking.
  73.           
  74.           CONFIGURATIONS:
  75.           
  76.           The following files must always be in the same directory:
  77.                M2SH.PRG       UTILITY.PRG
  78.                M2SH.RSC       UTILITY.RSC
  79.                M2SH.CFG
  80.                
  81.           UTILITY.PRG provides a number of disk utilities which are
  82.           accessible from within M2SH.PRG.  It does not, however, need
  83.           to be present.  When it is missing, the menu selections in
  84.           M2SH.PRG which represent the utility routines are simply
  85.           disabled.
  86.           
  87.           If you have a favorite editor you should use that instead of 
  88.           microEmacs.  We recommend TEMPUS by Creative Computer Design; 
  89.           it is an excellent GEM editor which interfaces closely with 
  90.           the Development Shell (see 'Editor Interface' below).
  91.           
  92.           Setup for 520ST (1/2 meg) with 2 single sided drives:
  93.           
  94.           The disk you will leave in drive A should contain the M2SH 
  95.           and UTILITY files along with your editor and source file.  
  96.           You should prepare Compiler and Linker disks for use in your
  97.           second drive.  The Compiler disk should hold M2.TOS, and a
  98.           subdirectory called something like M2LIB containing all the 
  99.           .SYM files.  The Linker disk should hold M2LNK.TOS, and a
  100.           subdirectory called something like M2LIB containing all the 
  101.           .OBJ files.  With this setup, just before you call the Compiler 
  102.           you must insert the Compiler disk and just before you call the 
  103.           Linker you must insert the Linker disk (into drive B).  If you 
  104.           are using this setup you can use the M2SH.CFG configuration file 
  105.           as supplied with the possible exception of changing the editor
  106.           name (see 'M2SH.CFG' below).
  107.           
  108.           Setup for 1040St (1 meg) with 1 double sided drive:
  109.           
  110.           You should prepare a double sided disk like the one for drive 
  111.           A in the 520ST setup and add to it M2.TOS and M2LNK.TOS.
  112.           You should also prepare a disk with the complete M2LIB
  113.           subdirectory (all .SYM and .OBJ files).  Then, upon bootup 
  114.           you should create a 200-300k RAM disk and load these two 
  115.           subdirectories onto it.  If you are using this set up you 
  116.           will need to adjust some of your M2SH.CFG configuration 
  117.           parameters (see 'M2SH.CFG' below).
  118.           
  119.           Setup for 1040St (1 meg) with 2 drives:
  120.           
  121.           If this is your hardware configuration you have, essentially, 
  122.           your choice of the two configurations given above.  If you 
  123.           want to run the Compiler and Linker from drive B, and if that 
  124.           drive is double sided, you should include on it M2.TOS and
  125.           M2LNK.TOS, along with the full M2LIB subdirectory.  Note
  126.           however that using a RAM disk will improve development speed.
  127.           
  128.           Setup for a system with a hard disk:
  129.           
  130.           You should create a MODULA_2 subdirectory and load the 
  131.           executables and library subdirectory into it.  You may then 
  132.           use the Shell locate facilities to install the various system 
  133.           programs (see 'M2SH.CFG' below).  This is of course the
  134.           recommended set both in terms of speed and convenience.
  135.           
  136.           NOTE: As stated, it is possible to run the whole system from
  137.           one double sided disk on 1/2 meg or more.  You must be careful, 
  138.           however, to leave room for the Compiler and Linker temporary 
  139.           files on the disk.  The amount of room needed depends on the size 
  140.           of the program you are building, and only experimentation will 
  141.           determine the limits.  (If you are sure you won't need any of the
  142.           disk utilities you might leave the UTILITY files off the disk).
  143.           Also, if you have a 1 meg (or greater) machine, you might ex-
  144.           periment more with ram disks to find the fastest and most
  145.           convenient setup.
  146.           
  147.           M2SH.CFG:
  148.           
  149.           The M2SH.CFG file contains a number of parameters which you 
  150.           may set from within the Shell.  Choosing 'Save Config' while 
  151.           in the Shell will alter M2SH.CFG to conform to the current 
  152.           settings.  Each time the Shell is run it looks for this file.  
  153.           If it is found, the Shell sets its parameters according to 
  154.           the file.  The parameters include location of the Editor, 
  155.           Compiler, and Linker among other things.  Most of the 
  156.           parameters are explained in the Shell help screens (press 
  157.           HELP when in the Shell).  
  158.           
  159.           Of interest here are the environment variable strings.  
  160.           These are system variables which the Compiler and Linker use 
  161.           to locate the Modula-2 libraries and to determine where to 
  162.           place temporary files.  The M2TMP variable tells the Compiler
  163.           and Linker where to put their temporary files (which are
  164.           deleted before the compile or link is finished).  The default
  165.           is the current directory.  The SYM and OBJ variables tell the
  166.           Compiler and Linker respectively where to find the libraries.
  167.           The default is, again, the current directory.  As supplied to
  168.           you, the variables (which you can view and change by selecting 
  169.           'Env Vars' from within the Shell) look like this: 
  170.           
  171.              SYM@B:\M2LIB\
  172.              OBJ@B:\M2LIB\
  173.              M2TMP=A:\
  174.           
  175.           The format of these strings is CRITICAL.  What they mean is
  176.           this:    the .SYM and .OBJ files are located in B:\M2LIB\ .
  177.           If you have merged all the .SYM and .OBJ files into one 
  178.           directory (as recommended for certain setups) and placed the 
  179.           directory on RAM drive D, you will need to change the 'B:\' 
  180.           to 'D:\' in both places.  The M2TMP variable simply says
  181.           that temperary files will be place on the root of drive B.
  182.           
  183.           If your libraries are in a deeper subdirectory, you might have
  184.           some thing like   SYM@B:\LIB\M2LIB\ .
  185.           If you want to put the Atari GEM libraries (aesvdi, aescalls, 
  186.           vdicalls) in a separate subdirectory you might have something
  187.           like  SYM@B:\LIB\M2LIB\@B:\LIB\M2GEMLIB\ .  Notice that there
  188.           are essentially two paths specified here, each starting with
  189.           the '@' symbol.
  190.  
  191.           LANGUAGE:
  192.           
  193.           The Shell loads the English version resource file by default.
  194.           If you wish to use the German version simply remove or re-
  195.           name the English version and the German version will be
  196.           loaded.
  197.           
  198.           EDITOR INTERFACE:
  199.           
  200.           The Shell provides two features which an editor can take 
  201.           advantage of to improve the ease and speed of development. 
  202.           The first is that if the editor returns an integer value of 1 
  203.           to the Shell when it terminates, the Shell will automatically 
  204.           invoke the Compiler, passing it the name of the file that was 
  205.           being edited.  (If you are using TEMPUS you would Quit and 
  206.           Save via Alt-(keypad)1.)  The second feature is that if 
  207.           syntax errors occur during compilation and you choose to 
  208.           return to the editor (at the prompt), the editor will be 
  209.           invoked with the names of the source file and the error file 
  210.           (.lst) on the command line.  If the editor is able to open 
  211.           multiple windows in response to commandline arguments you 
  212.           will get both files for easy error correction.  (TEMPUS will 
  213.           take advantage of this.)  The supplied version of microEmacs
  214.           will open only the source file, but you may open the error
  215.           listing by pressing (shift)F9 (see emacs.rc).
  216.           
  217.           LIBRARIES:
  218.           
  219.           The ana-systems Modula-2 libraries and the Atari specific
  220.           libraries are supplied to you combined.  The Atari specific
  221.           libraries are:
  222.                             aescalls.___
  223.                             vdicalls.___
  224.                             gemdos.___
  225.                             xbios.___
  226.                             bios.___
  227.                             
  228.           The DEFINITION modules for all libraries are also supplied.
  229.           Use these as a reference to the libraries.  In the case of 
  230.           the Atari libraries you will probably need reference manuals 
  231.           also (such as the excellent Compute's Technical Reference Guides). 
  232.           YOU MUST NOT COMPILE THESE DEFINITION MODULES AND THEN USE THE 
  233.           RESULTING .SYM FILES BECAUSE THE NEW TIME AND DATE STAMPS WILL 
  234.           PREVENT LINKAGE WITH THE CORRESPONDING .OBJ FILES.
  235.           
  236.           NOTES ON USING THE SYSTEM:
  237.           
  238.           If your system doesn't have a built in real time clock you 
  239.           should set the Control Panel clock on boot up in order to 
  240.           maintain the file date and time stamps.
  241.           
  242.           You may obtain help on any menu item by holding the ALT key 
  243.           while you click on the menu item.
  244.           
  245.           Items in the File and Execute menus may be selected via 
  246.           keyboard commands in addition to mouse clicks.  They all use 
  247.           control sequences -- you hold down the Control key while 
  248.           pressing the indicated character key (upper or lower case).
  249.           
  250.           You can't really get into trouble by just experimentally 
  251.           selecting menu items -- there is always a Cancel or Exit 
  252.           button which you can use before anything actually happens
  253.           (except in the case of 'Save config' -- no chance to cancel
  254.           is given here).
  255.           
  256.           The public domain editor microEmacs is included for your
  257.           convenience.  See the emacs.rc, .hlp, and .key files to
  258.           get started.  Various versions of microEmacs, along with
  259.           full documentation, are available on most bulletin boards.
  260.           
  261.           The Compiler and Linker may be run from a command line
  262.           environment such as Micro C Shell.  Take a look at M2SH.CFG
  263.           to see how you should set environment variables.  Full
  264.           documentation on use of the command line (including option
  265.           switches) is found in the Atari M2/68 User's Guide.
  266.           
  267.           When de-archiving with only single sided drives, put arc.ttp
  268.           on one drive and the arc file on the other.  This will leave
  269.           the necessary room.
  270.  
  271.